Package com.cisco.pt.ipc.sim
Interface DHCPServerProcess
- All Known Implementing Classes:
DHCPServerProcessImpl
Information provided by the PKI file:
\class DhcpServerProcess
\brief DhcpServerProcess is the process that handles DHCP pools and leases.
\example network().getDevice("Router0").getProcess("DhcpServer")
- Author:
- Auto-generated
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddExcludedAddress(IPAddress startIp, IPAddress endIp) Information provided by the PKI file:voidaddNewPool(String poolName, String gateway, String dnsServer, String startIp, String subnetMask, int maxUsers, String tftpServerIp, String wlcIp) Information provided by the PKI file:voidInformation provided by the PKI file:getExcludedAddressAt(int index) Information provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:getPoolAt(int index) Information provided by the PKI file:intInformation provided by the PKI file:booleanisEnable()Information provided by the PKI file:voidremoveExcludedAddress(IPAddress startIp, IPAddress endIp) Information provided by the PKI file:voidremovePool(String poolName) Information provided by the PKI file:voidsetEnable(boolean bEnable) Information provided by the PKI file:voidupdateNetworkReservation(IPAddress newNet) Methods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSessionMethods inherited from interface com.cisco.pt.ipc.sim.Process
getOwnerDevice
-
Method Details
-
addExcludedAddress
Information provided by the PKI file:
\brief Adds a range of IP addresses to exclude. \param startIp, the starting IP address. \param endIp, the ending IP address.- Parameters:
startIp- Takes in a parameter of startIpendIp- Takes in a parameter of endIp
-
removeExcludedAddress
Information provided by the PKI file:
\brief Removes the range of IP addresses to exclude. \param startIp, the starting IP address. \param endIp, the ending IP address.- Parameters:
startIp- Takes in a parameter of startIpendIp- Takes in a parameter of endIp
-
updateNetworkReservation
- Parameters:
newNet- Takes in a parameter of newNet
-
getExcludedAddressCount
int getExcludedAddressCount()Information provided by the PKI file:
\brief Returns the number of address ranges that is excluded. \return int, the number of address ranges that is excluded.- Returns:
- int Returns a int
-
getExcludedAddressAt
Information provided by the PKI file:
\brief Returns the excluded address range at the specified index. \param index, the index of excluded address range of interest. \return pair<ip,ip>, a pair of IP addresses, the first is the start IP address, the second is the end IP address.- Parameters:
index- Takes in a parameter of index- Returns:
- Pair<IPAddress, IPAddress> Returns a Pair<IPAddress, IPAddress>
-
addPool
Information provided by the PKI file:
\brief Adds a DHCP pool to this process. \param poolName, the name of the DHCP pool to add.- Parameters:
poolName- Takes in a parameter of poolName
-
addNewPool
void addNewPool(String poolName, String gateway, String dnsServer, String startIp, String subnetMask, int maxUsers, String tftpServerIp, String wlcIp) Information provided by the PKI file:
\brief Adds a new DHCP pool with the specified arguments. \param poolName, the name for the DHCP pool. \param gateway, the IP address of the default gateway. \param dnsServer, the IP address of the DNS server. \param startIp, the start IP address of the DHCP pool. \param subnetMask, the subnet mask of the DHCP pool. \param maxUsers, the maximum number of users for the DHCP pool. \param tftpServerIp, the IP address of the TFTP server. \param wlcIp, the IP address of the WLC.- Parameters:
poolName- Takes in a parameter of poolNamegateway- Takes in a parameter of gatewaydnsServer- Takes in a parameter of dnsServerstartIp- Takes in a parameter of startIpsubnetMask- Takes in a parameter of subnetMaskmaxUsers- Takes in a parameter of maxUserstftpServerIp- Takes in a parameter of tftpServerIpwlcIp- Takes in a parameter of wlcIp
-
getPool
Information provided by the PKI file:
\brief Returns a DhcpPool object with the specified pool name. \param poolName, the name of the DHCP pool of interest. \return DhcpPool, the DhcpPool object associated with the pool name.- Parameters:
poolName- Takes in a parameter of poolName- Returns:
- DHCPPool Returns a DHCPPool
-
removePool
Information provided by the PKI file:
\brief Removes the DHCP pool from this process. \param poolName, the name of the pool to remove.- Parameters:
poolName- Takes in a parameter of poolName
-
getPoolCount
int getPoolCount()Information provided by the PKI file:
\brief Returns the number of DHCP pools in this process. \return int, the number of DHCP pools in this process.- Returns:
- int Returns a int
-
getPoolAt
Information provided by the PKI file:
\brief Returns the DHCP pool at the specified index. \param index, the index of the DHCP pool of interest. \return DhcpPool, the DhcpPool object at the specified index.- Parameters:
index- Takes in a parameter of index- Returns:
- DHCPPool Returns a DHCPPool
-
isEnable
boolean isEnable()Information provided by the PKI file:
\brief Returns true if this DHCP server process is enabled, otherwise false. \return bool, true if this DHCP server process is enabled, otherwise false.- Returns:
- boolean Returns a boolean
-
setEnable
void setEnable(boolean bEnable) Information provided by the PKI file:
\brief Enables or disables this DHCP server process. \param bEnable, true to enable this DHCP server process, false to disable it.- Parameters:
bEnable- Takes in a parameter of bEnable
-